GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of notes to retrieve. Default is all notes |
integer |
None. |
skip |
Number of notes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the notes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Note |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "NoteId": "0db5b358-eaf3-41b0-aae3-caba39e2c178", "Asset": { "AssetId": "c7a780af-87fb-4cfd-8f26-e91219978bc7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "40e3cdc4-7ee4-47d3-b6a4-66fe25e39958", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f51d65ad-b87d-4528-b709-0622a0c3dd9d", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e4205f5b-9860-4324-8f48-8ae076b5be0b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "MeasurementValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "SourceSystemId": "sample string 3", "CompanyId": "434a247b-57b4-47f3-8246-109cf685b8cb", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "MeasurementValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b02b5502-06bb-4ccc-9dc8-25ae2f0e1de1", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "07988cdc-ccb9-48be-a3a2-bdf4defd3a33", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d522b44c-26a8-4106-a24b-630f9dbbc6ee", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-02T06:35:43.0478296-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "09d70bb9-7f79-41fc-b5b8-a9b3197f559e", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "0db5b358-eaf3-41b0-aae3-caba39e2c178", "Asset": { "AssetId": "c7a780af-87fb-4cfd-8f26-e91219978bc7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "40e3cdc4-7ee4-47d3-b6a4-66fe25e39958", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f51d65ad-b87d-4528-b709-0622a0c3dd9d", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e4205f5b-9860-4324-8f48-8ae076b5be0b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "MeasurementValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "SourceSystemId": "sample string 3", "CompanyId": "434a247b-57b4-47f3-8246-109cf685b8cb", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "MeasurementValueNeededDate": "2024-05-02T06:35:43.0478296-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b02b5502-06bb-4ccc-9dc8-25ae2f0e1de1", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "07988cdc-ccb9-48be-a3a2-bdf4defd3a33", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "d522b44c-26a8-4106-a24b-630f9dbbc6ee", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-02T06:35:43.0478296-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "09d70bb9-7f79-41fc-b5b8-a9b3197f559e", "CreateDate": "2024-05-02T06:35:43.0478296-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-02T06:35:43.0478296-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }